1. 회사명 관리

1.1 회사명 검색

o 기능 : 데이터베이스에 등록된 회사명 목록을 확인

o  URL  :  /api/sw/company?[lang={lang_code}]&[type={type_code}]& [first_char={char_value}]

- lang : C3의 해외 판매에 대비, 특정 언어의 회사명만을 검색하기 위해 사용

- type : 향후 C3 이외 다른 제품이 추가되었을 때, 특정 제품 관련 회사명만을 검색하기 위한 것으로, C3의 type_code로는 ‘1’을 사용

- first_char : 회사명이 과다해지는 상황에 대비, 특정 문자로 시작하는 회사명만을 검색하기 위해 사용

o 모드 : GET

o 응답 형식 : application/json

o 응답 데이터

[

{

“com” : "{com_name}"

},

⋅⋅⋅

{

“com” : "{com_name}"

}

]

* 응답 데이터를 올림차순으로 정렬하여 전달

1.2 회사명 등록

o 기능 : 데이터베이스에 신규 회사명을 등록

o  URL  :  /api/sw/company/:com_name?[lang={lang_code}]&[type={type_code}]

* lang 및 type은 ‘회사명 검색’과 동일

o 모드 : GET

o 응답 형식 : text/plain

o 응답 데이터

200 OK

1.3 회사명 삭제

o 기능 : 데이터베이스에서 특정 회사명을 삭제

o  URL  :  /api/sw/company/:com_name?[lang={lang_code}]&[type={type_code}]

* lang 및 type은 ‘회사명 검색’과 동일

o 모드 : DELETE

o 응답 형식 : text/plain

o 응답 데이터

200 OK

2. 현장명 관리

2.1 현장명 검색

o 기능 : 데이터베이스에 등록된 현장명 목록을 확인

o  URL  :  /api/sw/site/:com_name

o 모드 : GET

o 응답 형식 : application/json

o 응답 데이터

[

{

“site” : "{site_name}"

},

⋅⋅⋅

{

“site” : "{site_name}"

}

]

* 응답 데이터를 올림차순으로 정렬하여 전달

2.2 현장명 등록

o 기능 : 데이터베이스에 신규 현장명을 등록

o  URL  :  /api/sw/site/:com_name/:site_name

o 모드 : GET

o 응답 형식 : text/plain

o 응답 데이터

200 OK

2.3 현장명 삭제

o 기능 : 데이터베이스에서 특정 현장명을 삭제

o  URL  :  /api/sw/company/:com_name/:site_name

o 모드 : DELETE

o 응답 형식 : text/plain

o 응답 데이터

200 OK

3. 디바이스 관리

3.1 디바이스 등록

o 기능 : 디바이스를 등록하고 생성한 DeviceID를 전달

o  URL  :  /api/sw/device?[company={com_name}]&&[site={site_name}]

o 모드 : POST

o 전달 데이터

{

“id” :　“XXX”,

“type” : 1,

“hw” : “{CPUID}”,

“sw” : “{VersionInfo}”,

“ble” : “{BLEID}”

}

o 응답 형식 : application/json

o 응답 데이터

{

“id” : “SW2410C00001”

}

3.2 디바이스 현장 정보 확인

o 기능 : 데이터베이스에 등록된 디바이스의 현장 정보를 확인

o URL : /api/sw/device/site/:id

o 모드 : GET

o 응답 형식 : application/json

o 응답 데이터

{

“com” : “{com_name}”,

“site” : “{site_name}”

}

{

“com” : null,

“site” : null

}

404 Not Found

3.3 디바이스 현장 정보 설정

o 기능 : 데이터베이스에 등록된 디바이스의 현장 정보를 설정

o URL : /api/sw/device/site/:id/:com_name/:site_name

o 모드 : GET

o 응답 형식 : text/plain

o 응답 데이터

200 OK

404 Not Found

3.4 디바이스 설정 권한 등록

o 기능 : 데이터베이스에 등록된 디바이스의 설정 권한을 등록

o URL : /api/sw/device/acl

o 모드 : POST

o 전달 데이터

[

{

“id” : “SW2410C00001”,

“acl” : “00000000“

},

⋅⋅⋅

{

“id” : “SW2410C00010”,

“acl” : “11000000“

}

]

* acl 1번째 : 검출 모드, 2번째 : 격발 중지, 3번째 : 임시 중지, 4번째 : 수동 격발

o 응답 데이터

200 OK

500 Internal Server Error

3.5 디바이스 설정 권한 확인

o 기능 : 데이터베이스에 등록된 디바이스의 설정 권한을 확인

o URL : /api/sw/device/acl/:id

o 모드 : GET

o 응답 형식 : application/json

o 응답 데이터

{

“id” : “{dev_id}”,

“acl” : “{acl_code}”

}

404 Not Found

500 Internal Server Error

3.6 특정 현장 디바이스 목록 확인

o 기능 : 특정 현장명으로 등록된 디바이스 목록을 확인

o URL : /api/sw/device/list/:site?[mode={mode_value}]

o 모드 : GET

o 응답 형식 : application/json

o 응답 데이터(mode=1, default, 이름 기준)

[

{

"name": "Test",

"id": "TEST0001",

"bat": 80,

"st": 0,

"time": 777,

"gps": "10.0,20.0"

},

{

"name": "Test",

"id": "TEST0002",

"bat": 70,

"st": 1,

"time": 6070,

"gps": null

}

]

* st(0) : off, st(1) : on, time : 사용시간(초단위)

o 응답 데이터(mode=2, ID 기준)

[

{

"id": "SF_001",

"name": null,

"bat": null,

"st": 0,

"time": 0,

"gps": null

},

{

"id": "TEST0001",

"name": "Test",

"bat": 80,

"st": 0,

"time": 777,

"gps": "10.0,20.0"

},

⋅⋅⋅

{

"id": "TEST0002",

"name": "Test",

"bat": 70,

"st": 1,

"time": 5974,

"gps": null

}

]

404 Not Found

500 Internal Server Error